Weapon Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`bool`	`isValid()Returns whether this weapon pointer is still valid. A weapon pointer becomes invalid when the weapon fades away or disappears or Link leaves the screen. Accessing any variables using an invalid weapon pointer prints an error message to allegro.log and does nothing.`
`void`	`UseSprite(int id)Reads a 'Weapons/Misc' sprite entry in your quest file, and assigns the OriginalTile, Tile, OriginalCSet, CSet, FlashCSet, NumFrames Frame, ASpeed, Flip and Flash variables of this weapon based on this entry's data. Passing negative values, and values greater than 255, will do nothing.`
`bool`	`BehindEnsures that the weapon's graphic is drawn behind Link and enemies.`
`int`	`IDThe weapon's ID number. Use the LW_ or EW_ constants to compare this value. The effect of writing to this field is currently undefined.`
`int`	`XThe weapon's X position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`YThe weapon's Y position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`ZThe weapon's Z position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`JumpThe weapon's falling speed on the screen. Bombs, Bait and Fire obey gravity.`
`int`	`DrawStyleAn integer representing how the weapon is to be drawn. Use one of the DS_ constants in std.zh to set or compare this value.`
`int`	`DirThe direction that the weapon is facing. Used by certain weapon types to determine movement, shield deflection and such.`
`int`	`OriginalTileThe starting tile of the weapon's animation.`
`int`	`TileThe current tile associated with this weapon.`
`int`	`OriginalCSetThe starting CSet of the weapon's animation.`
`int`	`CSetThis weapon's current CSet.`
`int`	`FlashCSetThe CSet used during this weapon's flash frames, if this weapon flashes.`
`int`	`NumFramesThe number of frames in this weapon's animation.`
`int`	`FrameThe weapon's current animation frame.`
`int`	`ASpeedThe speed at which this weapon animates, in screen frames.`
`int`	`DamageThe amount of damage that this weapon causes to Link/an enemy upon contact.`
`int`	`StepUsually associated with the weapon's velocity. A Step of 100 typically means that the weapon moves at approximately one pixel per animation frame.`
`int`	`AngleThe weapon's current angle in clockwise radians; used by certain weapon types with angular movement. 0 = right, PI/2 = down, etc. Note: if you want Link's shield to interact with the weapon correctly, you must set its Dir to a direction that approximates this angle.`
`bool`	`AngularSpecifies whether a weapon has angular movement.`
`bool`	`CollDetectionWhether the weapon will use the system's code to work out collisions with Link and/or enemies (depending on weapon type). Initialised as 'true'.`
`int`	DeadStateThe current state of the weapon. Important to keep track of. A value of -1 indicates that it is active, and moves according to the weapon's Dir, Step, Angular, and Angle values. Use -1 if you want the engine to handle movement and collision. Use any value below -1 if you want a dummy weapon that you can control on your own. Given a deadstate value of -10, a weapon will turn of its collision detection and movement. If it has a positive value, it will decrement once per frame until it equals 0, whereupon the weapon is removed. If you want to remove the weapon, write one of the WDS_ constants in std.zh (appropriate for the weapon) to this variable.
`bool`	`FlashWhether or not the weapon flashes. A flashing weapon alternates between its CSet and its FlashCSet.`
`int`	`FlipWhether and how the weapon's tiles should be flipped. 0: No flip 1: Horizontal flip 2: Vertical flip 3: Both (180 degree rotation)`
`int`	`ExtendWhether to extend the sprite of the weapon.`
`int`	`TileWidthThe number of tile columns composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`TileHeightThe number of tile rows composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`HitWidthThe width of the sprite's hitbox, or collision rectangle.`
`int`	`HitHeightThe height of the sprite's hitbox, or collision rectangle.`
`int`	`HitZHeightThe Z-axis height of the sprite's hitbox, or collision rectangle. The greater it is, the higher Link must jump or fly over the sprite to avoid taking damage.`
`int`	`HitXOffsetThe X offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox left or right.`
`int`	`HitYOffsetThe Y offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox up or down.`
`int`	`DrawXOffsetThe X offset of the sprite. Setting it to positive or negative values will move the sprite's tiles left or right relative to its position.`
`int`	`DrawYOffsetThe Y offset of the sprite. Setting it to positive or negative values will move the sprite's tiles up or down relative to its position.`
`int`	`DrawZOffsetThe Z offset of the sprite.`
`float`	`Misc[]An array of 16 miscellaneous variables for you to use as you please.`